<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <!-- For Mobile Devices -->
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
        <meta name="generator" content="Doxygen 1.8.18"/>
        <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
        <title>HElib: helib::ArgMap Class Reference</title>
        <!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
        <script type="text/javascript" src="dynsections.js"></script>
        <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
        <link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
		<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,100;1,700&family=Merriweather&family=Merriweather+Sans&family=Open+Sans&family=Poppins:ital@1&family=Roboto:ital,wght@0,400;1,300;1,900&display=swap" rel="stylesheet"> 
        <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css">
        <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"></script>
        <link href="jquery.smartmenus.bootstrap.css" rel="stylesheet">
        <script type="text/javascript" src="jquery.smartmenus.js"></script>
        <!-- SmartMenus jQuery Bootstrap Addon -->
        <script type="text/javascript" src="jquery.smartmenus.bootstrap.js"></script>
        <!-- SmartMenus jQuery plugin -->
    </head>
    <body style="font-family: 'Merriweather', serif;">
        <nav class="navbar navbar-default" role="navigation">
            <div class="container">
                <div class="navbar-header">
                    <a class="navbar-brand">HElib Implementing Homomorphic Encryption</a>
                </div>
            </div>
        </nav>
        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
            <div class="content" id="content">
                <div class="container">
                    <div class="row">
                        <div class="col-sm-12 panel " style="padding-bottom: 15px;">
                            <div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacehelib.html">helib</a></li><li class="navelem"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classhelib_1_1_arg_map-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">helib::ArgMap Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Basic class for arg parsing. Example use:  
 <a href="classhelib_1_1_arg_map.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_arg_map_8h_source.html">ArgMap.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structhelib_1_1_arg_map_1_1_arg_processor.html">ArgProcessor</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac96d090b5476e9a39b41ae27d74641b0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0">Separator</a> { <a class="el" href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0af65f22e75defc168edfc6444e6aaf4f8">Separator::COLON</a>, 
<a class="el" href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0a6837aeca94b8f55801166eb031e26a5a">Separator::EQUALS</a>, 
<a class="el" href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0a52f1e315372b38db1b8f4e3666c4f721">Separator::WHITESPACE</a>
 }</td></tr>
<tr class="separator:ac96d090b5476e9a39b41ae27d74641b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a72a8c34a4d72036f02d3bb3cc6f754d2"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a72a8c34a4d72036f02d3bb3cc6f754d2"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a72a8c34a4d72036f02d3bb3cc6f754d2">arg</a> (const std::string &amp;name, T &amp;value)</td></tr>
<tr class="memdesc:a72a8c34a4d72036f02d3bb3cc6f754d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new argument description Adds a new argument description with value of type T. Throws <a class="el" href="classhelib_1_1_runtime_error.html" title="Inherits from Exception and std::runtime_error.">helib::RuntimeError</a> if the arg key is duplicated or if the storing variable is used more than once.  <a href="classhelib_1_1_arg_map.html#a72a8c34a4d72036f02d3bb3cc6f754d2">More...</a><br /></td></tr>
<tr class="separator:a72a8c34a4d72036f02d3bb3cc6f754d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42478737c5cde2588dd05507ba223c18"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a42478737c5cde2588dd05507ba223c18"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a42478737c5cde2588dd05507ba223c18">arg</a> (const std::string &amp;name, T &amp;value, const std::string &amp;<a class="el" href="classhelib_1_1_arg_map.html#a7665dba84ba3a420e052a61eb6c4e30f">doc</a>)</td></tr>
<tr class="memdesc:a42478737c5cde2588dd05507ba223c18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new argument with docs Adds a new argument description with value of type T and docs. Throws <a class="el" href="classhelib_1_1_runtime_error.html" title="Inherits from Exception and std::runtime_error.">helib::RuntimeError</a> if the arg key is duplicated or if the storing variable is used more than once.  <a href="classhelib_1_1_arg_map.html#a42478737c5cde2588dd05507ba223c18">More...</a><br /></td></tr>
<tr class="separator:a42478737c5cde2588dd05507ba223c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41267f47c1fcd1b8d7ba4d0a38fc0f47"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a41267f47c1fcd1b8d7ba4d0a38fc0f47"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a41267f47c1fcd1b8d7ba4d0a38fc0f47">arg</a> (const std::string &amp;name, T &amp;value, const std::string &amp;<a class="el" href="classhelib_1_1_arg_map.html#a7665dba84ba3a420e052a61eb6c4e30f">doc</a>, const char *info)</td></tr>
<tr class="memdesc:a41267f47c1fcd1b8d7ba4d0a38fc0f47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new argument with docs and default description Adds a new argument description with value of type T, with docs and default description. Throws <a class="el" href="classhelib_1_1_runtime_error.html" title="Inherits from Exception and std::runtime_error.">helib::RuntimeError</a> if the arg key is duplicated or if the storing variable is used more than once.  <a href="classhelib_1_1_arg_map.html#a41267f47c1fcd1b8d7ba4d0a38fc0f47">More...</a><br /></td></tr>
<tr class="separator:a41267f47c1fcd1b8d7ba4d0a38fc0f47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e2a662a2283329301f6d7b5e0e845c8"><td class="memTemplParams" colspan="2">template&lt;typename C &gt; </td></tr>
<tr class="memitem:a8e2a662a2283329301f6d7b5e0e845c8"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a8e2a662a2283329301f6d7b5e0e845c8">dots</a> (C &amp;container, const char *name)</td></tr>
<tr class="memdesc:a8e2a662a2283329301f6d7b5e0e845c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds variable number of positional arg types after defined arg types are exhausted. These are treated as optional.  <a href="classhelib_1_1_arg_map.html#a8e2a662a2283329301f6d7b5e0e845c8">More...</a><br /></td></tr>
<tr class="separator:a8e2a662a2283329301f6d7b5e0e845c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89eee5d391a2fd41b6b6c4b545b159b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a89eee5d391a2fd41b6b6c4b545b159b7">parse</a> (int argc, char **argv)</td></tr>
<tr class="memdesc:a89eee5d391a2fd41b6b6c4b545b159b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the argv array Parse the argv array If it fails or -h is an argument it prints the usage and exits the program.  <a href="classhelib_1_1_arg_map.html#a89eee5d391a2fd41b6b6c4b545b159b7">More...</a><br /></td></tr>
<tr class="separator:a89eee5d391a2fd41b6b6c4b545b159b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c4e6cd32fd18c78bc02d11f74bf115b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a5c4e6cd32fd18c78bc02d11f74bf115b">parse</a> (const std::string &amp;filepath)</td></tr>
<tr class="memdesc:a5c4e6cd32fd18c78bc02d11f74bf115b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the configuration/parameters file Parsing a configuration file only functions with named arguments Parse the config file Throws <a class="el" href="classhelib_1_1_runtime_error.html" title="Inherits from Exception and std::runtime_error.">RuntimeError</a> on failure.  <a href="classhelib_1_1_arg_map.html#a5c4e6cd32fd18c78bc02d11f74bf115b">More...</a><br /></td></tr>
<tr class="separator:a5c4e6cd32fd18c78bc02d11f74bf115b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39ddbc25b7e1b038dbab65d5c1383b50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a39ddbc25b7e1b038dbab65d5c1383b50">optional</a> ()</td></tr>
<tr class="memdesc:a39ddbc25b7e1b038dbab65d5c1383b50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Swaps to optional arg mode (default) Swaps to optional arg mode. Following arguments will be considered optional.  <a href="classhelib_1_1_arg_map.html#a39ddbc25b7e1b038dbab65d5c1383b50">More...</a><br /></td></tr>
<tr class="separator:a39ddbc25b7e1b038dbab65d5c1383b50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7dcd50df0466cd4be10a94eb3f96d1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#aa7dcd50df0466cd4be10a94eb3f96d1b">required</a> ()</td></tr>
<tr class="memdesc:aa7dcd50df0466cd4be10a94eb3f96d1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Swaps to required arg mode Swaps to required arg mode. Following arguments will be considered required.  <a href="classhelib_1_1_arg_map.html#aa7dcd50df0466cd4be10a94eb3f96d1b">More...</a><br /></td></tr>
<tr class="separator:aa7dcd50df0466cd4be10a94eb3f96d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af838c44fcb91c73284de3cbf993861f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#af838c44fcb91c73284de3cbf993861f2">toggle</a> (bool t=true)</td></tr>
<tr class="memdesc:af838c44fcb91c73284de3cbf993861f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Swaps to toggle arg type Swaps to required arg mode. Following arguments will be considered of toggle type.  <a href="classhelib_1_1_arg_map.html#af838c44fcb91c73284de3cbf993861f2">More...</a><br /></td></tr>
<tr class="separator:af838c44fcb91c73284de3cbf993861f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac06dd5e3726ecd5d8e688d665c2c9e50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#ac06dd5e3726ecd5d8e688d665c2c9e50">named</a> ()</td></tr>
<tr class="memdesc:ac06dd5e3726ecd5d8e688d665c2c9e50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Swaps to named arg type (default) Swaps to required arg mode. Following arguments will be considered of named type.  <a href="classhelib_1_1_arg_map.html#ac06dd5e3726ecd5d8e688d665c2c9e50">More...</a><br /></td></tr>
<tr class="separator:ac06dd5e3726ecd5d8e688d665c2c9e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf55e7e52a63bd72fe212cb90e58ad64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#adf55e7e52a63bd72fe212cb90e58ad64">positional</a> ()</td></tr>
<tr class="memdesc:adf55e7e52a63bd72fe212cb90e58ad64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Swaps to positional arg type Swaps to required arg mode. Following arguments will be considered of positional type.  <a href="classhelib_1_1_arg_map.html#adf55e7e52a63bd72fe212cb90e58ad64">More...</a><br /></td></tr>
<tr class="separator:adf55e7e52a63bd72fe212cb90e58ad64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ecab734381e89bf13e2dd38af25585c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a0ecab734381e89bf13e2dd38af25585c">helpArgs</a> (const std::initializer_list&lt; std::string &gt; s)</td></tr>
<tr class="memdesc:a0ecab734381e89bf13e2dd38af25585c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provide custom help toggle args. (defaults are "-h", "--help") Overwrite default help toggle args to custom ones for parsing.  <a href="classhelib_1_1_arg_map.html#a0ecab734381e89bf13e2dd38af25585c">More...</a><br /></td></tr>
<tr class="separator:a0ecab734381e89bf13e2dd38af25585c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec9f54ce4e5c048da7d35c2a23688a75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#aec9f54ce4e5c048da7d35c2a23688a75">helpArgs</a> (const std::string s)</td></tr>
<tr class="separator:aec9f54ce4e5c048da7d35c2a23688a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af54e2d261ed329d3b3b2e2cfbf35ab80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#af54e2d261ed329d3b3b2e2cfbf35ab80">diagnostics</a> (std::ostream &amp;ostrm=std::cout)</td></tr>
<tr class="memdesc:af54e2d261ed329d3b3b2e2cfbf35ab80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Turns on diagnostics printout when parsing Swaps to required arg mode. Following arguments will be considered of positional type.  <a href="classhelib_1_1_arg_map.html#af54e2d261ed329d3b3b2e2cfbf35ab80">More...</a><br /></td></tr>
<tr class="separator:af54e2d261ed329d3b3b2e2cfbf35ab80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae477d3e97e6b9f4e847b7976fc939992"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#ae477d3e97e6b9f4e847b7976fc939992">separator</a> (<a class="el" href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0">Separator</a> s)</td></tr>
<tr class="memdesc:ae477d3e97e6b9f4e847b7976fc939992"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the key-value separator Sets the named args key-value pair separator character.  <a href="classhelib_1_1_arg_map.html#ae477d3e97e6b9f4e847b7976fc939992">More...</a><br /></td></tr>
<tr class="separator:ae477d3e97e6b9f4e847b7976fc939992"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bcbfcccc0c9fcc9f3eba06067fcd97f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a7bcbfcccc0c9fcc9f3eba06067fcd97f">note</a> (const std::string &amp;s)</td></tr>
<tr class="memdesc:a7bcbfcccc0c9fcc9f3eba06067fcd97f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a note to usage Adds a note to the arg usage description.  <a href="classhelib_1_1_arg_map.html#a7bcbfcccc0c9fcc9f3eba06067fcd97f">More...</a><br /></td></tr>
<tr class="separator:a7bcbfcccc0c9fcc9f3eba06067fcd97f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a383d5eb53291ab618eebeb60c2112dde"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a383d5eb53291ab618eebeb60c2112dde">usage</a> (const std::string &amp;msg=&quot;&quot;) const</td></tr>
<tr class="memdesc:a383d5eb53291ab618eebeb60c2112dde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print usage and exit Prints the usage and exits the program.  <a href="classhelib_1_1_arg_map.html#a383d5eb53291ab618eebeb60c2112dde">More...</a><br /></td></tr>
<tr class="separator:a383d5eb53291ab618eebeb60c2112dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7665dba84ba3a420e052a61eb6c4e30f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhelib_1_1_arg_map.html#a7665dba84ba3a420e052a61eb6c4e30f">doc</a> () const</td></tr>
<tr class="memdesc:a7665dba84ba3a420e052a61eb6c4e30f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return arg docs Returns the argument documentation as a string.  <a href="classhelib_1_1_arg_map.html#a7665dba84ba3a420e052a61eb6c4e30f">More...</a><br /></td></tr>
<tr class="separator:a7665dba84ba3a420e052a61eb6c4e30f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Basic class for arg parsing. Example use: </p>
<div class="fragment"><div class="line"><span class="comment">// Variables to be set by command line.</span></div>
<div class="line"><span class="keywordtype">long</span> p = 2;                                 <span class="comment">// default values.</span></div>
<div class="line"><span class="keywordtype">long</span> m = 19;</div>
<div class="line"><span class="keywordtype">bool</span> t = <span class="keyword">false</span>;</div>
<div class="line"><span class="keywordtype">bool</span> f = <span class="keyword">true</span>;</div>
<div class="line">std::string k = <span class="stringliteral">&quot;Hello World&quot;</span>;</div>
<div class="line"> </div>
<div class="line">ArgMap()                                    <span class="comment">// (*) marks default.</span></div>
<div class="line">  .required()                               <span class="comment">// set args to required.</span></div>
<div class="line">  .positional()                             <span class="comment">//</span></div>
<div class="line">    .arg(<span class="stringliteral">&quot;p&quot;</span>, p, <span class="stringliteral">&quot;doc for p&quot;</span>)               <span class="comment">//</span></div>
<div class="line">    .arg(<span class="stringliteral">&quot;m&quot;</span>, m, <span class="stringliteral">&quot;doc for m&quot;</span>, <span class="stringliteral">&quot;undefined&quot;</span>)  <span class="comment">// special default info.</span></div>
<div class="line">  .optional()                               <span class="comment">// swap to optional args (*).</span></div>
<div class="line">  .named()                                  <span class="comment">// named args (*) e.g.k=v.</span></div>
<div class="line">  .separator(<a class="code" href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0a52f1e315372b38db1b8f4e3666c4f721">ArgMap::Separator::WHITESPACE</a>) <span class="comment">// change separator to</span></div>
<div class="line">    .arg(<span class="stringliteral">&quot;-k&quot;</span>, k, <span class="stringliteral">&quot;doc for k&quot;</span>, <span class="stringliteral">&quot;&quot;</span>)          <span class="comment">// whitespace (&#39;=&#39; is (*)).</span></div>
<div class="line">    .note(<span class="stringliteral">&quot;an extra note&quot;</span>)                  <span class="comment">// no default value info.</span></div>
<div class="line">  .toggle()                                 <span class="comment">// add extra doc/note.</span></div>
<div class="line">     .arg(<span class="stringliteral">&quot;-t&quot;</span>, t, <span class="stringliteral">&quot;doc for t&quot;</span>, <span class="stringliteral">&quot;&quot;</span>)         <span class="comment">// toggle flag sets bool true.</span></div>
<div class="line">  .toggle(<span class="keyword">false</span>)                            <span class="comment">// toggle flag sets bool false.</span></div>
<div class="line">     .arg(<span class="stringliteral">&quot;-f&quot;</span>, f, <span class="stringliteral">&quot;doc for f&quot;</span>, <span class="stringliteral">&quot;&quot;</span>)         <span class="comment">//</span></div>
<div class="line">  .helpArgs({<span class="stringliteral">&quot;--myhelp&quot;</span>})                   <span class="comment">// changes default help flags</span></div>
<div class="line">  .<a class="code" href="classhelib_1_1_arg_map.html#a89eee5d391a2fd41b6b6c4b545b159b7">parse</a>(argc, argv);                       <span class="comment">// (*) is {&quot;-h&quot;, &quot;--help&quot;}.</span></div>
<div class="line">                                            <span class="comment">// parses and overwrites values</span></div>
</div><!-- fragment --> </div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ac96d090b5476e9a39b41ae27d74641b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac96d090b5476e9a39b41ae27d74641b0">&#9670;&nbsp;</a></span>Separator</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0">helib::ArgMap::Separator</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac96d090b5476e9a39b41ae27d74641b0af65f22e75defc168edfc6444e6aaf4f8"></a>COLON&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac96d090b5476e9a39b41ae27d74641b0a6837aeca94b8f55801166eb031e26a5a"></a>EQUALS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac96d090b5476e9a39b41ae27d74641b0a52f1e315372b38db1b8f4e3666c4f721"></a>WHITESPACE&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a72a8c34a4d72036f02d3bb3cc6f754d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72a8c34a4d72036f02d3bb3cc6f754d2">&#9670;&nbsp;</a></span>arg() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::arg </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T &amp;&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a new argument description Adds a new argument description with value of type T. Throws <a class="el" href="classhelib_1_1_runtime_error.html" title="Inherits from Exception and std::runtime_error.">helib::RuntimeError</a> if the arg key is duplicated or if the storing variable is used more than once. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>The type of the argument </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The argument name (key) </td></tr>
    <tr><td class="paramname">value</td><td>a variable where the argument will be stored. Also used as default value </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the modified <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a42478737c5cde2588dd05507ba223c18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42478737c5cde2588dd05507ba223c18">&#9670;&nbsp;</a></span>arg() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::arg </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T &amp;&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>doc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a new argument with docs Adds a new argument description with value of type T and docs. Throws <a class="el" href="classhelib_1_1_runtime_error.html" title="Inherits from Exception and std::runtime_error.">helib::RuntimeError</a> if the arg key is duplicated or if the storing variable is used more than once. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>The type of the argument </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The argument name (key) </td></tr>
    <tr><td class="paramname">value</td><td>a variable where the argument will be stored. Also used as default value </td></tr>
    <tr><td class="paramname">doc1</td><td>Description of the argument used when displaying usage </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the modified <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a41267f47c1fcd1b8d7ba4d0a38fc0f47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41267f47c1fcd1b8d7ba4d0a38fc0f47">&#9670;&nbsp;</a></span>arg() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::arg </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T &amp;&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>doc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>info</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a new argument with docs and default description Adds a new argument description with value of type T, with docs and default description. Throws <a class="el" href="classhelib_1_1_runtime_error.html" title="Inherits from Exception and std::runtime_error.">helib::RuntimeError</a> if the arg key is duplicated or if the storing variable is used more than once. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>The type of the argument </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The argument name (key) </td></tr>
    <tr><td class="paramname">value</td><td>a variable where the argument will be stored. Also used as default value </td></tr>
    <tr><td class="paramname">doc1</td><td>Description of the argument used when displaying usage </td></tr>
    <tr><td class="paramname">info</td><td>The default value description (ignored if nullptr or "") </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the modified <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="af54e2d261ed329d3b3b2e2cfbf35ab80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af54e2d261ed329d3b3b2e2cfbf35ab80">&#9670;&nbsp;</a></span>diagnostics()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::diagnostics </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>ostrm</em> = <code>std::cout</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Turns on diagnostics printout when parsing Swaps to required arg mode. Following arguments will be considered of positional type. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a7665dba84ba3a420e052a61eb6c4e30f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7665dba84ba3a420e052a61eb6c4e30f">&#9670;&nbsp;</a></span>doc()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string helib::ArgMap::doc </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return arg docs Returns the argument documentation as a string. </p>
<dl class="section return"><dt>Returns</dt><dd>the argument documentation string </dd></dl>

</div>
</div>
<a id="a8e2a662a2283329301f6d7b5e0e845c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e2a662a2283329301f6d7b5e0e845c8">&#9670;&nbsp;</a></span>dots()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename C &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::dots </td>
          <td>(</td>
          <td class="paramtype">C &amp;&#160;</td>
          <td class="paramname"><em>container</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Adds variable number of positional arg types after defined arg types are exhausted. These are treated as optional. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">container</td><td>holds the variable positional args. It must have a push_back method for insertion </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a0ecab734381e89bf13e2dd38af25585c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ecab734381e89bf13e2dd38af25585c">&#9670;&nbsp;</a></span>helpArgs() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::helpArgs </td>
          <td>(</td>
          <td class="paramtype">const std::initializer_list&lt; std::string &gt;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Provide custom help toggle args. (defaults are "-h", "--help") Overwrite default help toggle args to custom ones for parsing. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="aec9f54ce4e5c048da7d35c2a23688a75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec9f54ce4e5c048da7d35c2a23688a75">&#9670;&nbsp;</a></span>helpArgs() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::helpArgs </td>
          <td>(</td>
          <td class="paramtype">const std::string&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ac06dd5e3726ecd5d8e688d665c2c9e50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac06dd5e3726ecd5d8e688d665c2c9e50">&#9670;&nbsp;</a></span>named()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::named </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Swaps to named arg type (default) Swaps to required arg mode. Following arguments will be considered of named type. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a7bcbfcccc0c9fcc9f3eba06067fcd97f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bcbfcccc0c9fcc9f3eba06067fcd97f">&#9670;&nbsp;</a></span>note()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::note </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds a note to usage Adds a note to the arg usage description. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">s</td><td>The note string </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a39ddbc25b7e1b038dbab65d5c1383b50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39ddbc25b7e1b038dbab65d5c1383b50">&#9670;&nbsp;</a></span>optional()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::optional </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Swaps to optional arg mode (default) Swaps to optional arg mode. Following arguments will be considered optional. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a5c4e6cd32fd18c78bc02d11f74bf115b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c4e6cd32fd18c78bc02d11f74bf115b">&#9670;&nbsp;</a></span>parse() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::parse </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>filepath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse the configuration/parameters file Parsing a configuration file only functions with named arguments Parse the config file Throws <a class="el" href="classhelib_1_1_runtime_error.html" title="Inherits from Exception and std::runtime_error.">RuntimeError</a> on failure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filepath</td><td>the config file path </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a89eee5d391a2fd41b6b6c4b545b159b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89eee5d391a2fd41b6b6c4b545b159b7">&#9670;&nbsp;</a></span>parse() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::parse </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>argv</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse the argv array Parse the argv array If it fails or -h is an argument it prints the usage and exits the program. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">argc</td><td>number of entries in argv </td></tr>
    <tr><td class="paramname">argv</td><td>array containing the arguments </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="adf55e7e52a63bd72fe212cb90e58ad64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf55e7e52a63bd72fe212cb90e58ad64">&#9670;&nbsp;</a></span>positional()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::positional </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Swaps to positional arg type Swaps to required arg mode. Following arguments will be considered of positional type. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="aa7dcd50df0466cd4be10a94eb3f96d1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7dcd50df0466cd4be10a94eb3f96d1b">&#9670;&nbsp;</a></span>required()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::required </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Swaps to required arg mode Swaps to required arg mode. Following arguments will be considered required. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="ae477d3e97e6b9f4e847b7976fc939992"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae477d3e97e6b9f4e847b7976fc939992">&#9670;&nbsp;</a></span>separator()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::separator </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0">Separator</a>&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sets the key-value separator Sets the named args key-value pair separator character. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">s</td><td>the separator enum must be set either to COLON or EQUALS(default). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="af838c44fcb91c73284de3cbf993861f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af838c44fcb91c73284de3cbf993861f2">&#9670;&nbsp;</a></span>toggle()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhelib_1_1_arg_map.html">ArgMap</a> &amp; helib::ArgMap::toggle </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>t</em> = <code>true</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Swaps to toggle arg type Swaps to required arg mode. Following arguments will be considered of toggle type. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the <a class="el" href="classhelib_1_1_arg_map.html" title="Basic class for arg parsing. Example use:">ArgMap</a> object </dd></dl>

</div>
</div>
<a id="a383d5eb53291ab618eebeb60c2112dde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a383d5eb53291ab618eebeb60c2112dde">&#9670;&nbsp;</a></span>usage()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void helib::ArgMap::usage </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>msg</em> = <code>&quot;&quot;</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Print usage and exit Prints the usage and exits the program. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg</td><td>An additional message to print before showing usage </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/HElib/include/helib/<a class="el" href="_arg_map_8h_source.html">ArgMap.h</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclasshelib_1_1_arg_map_html_a89eee5d391a2fd41b6b6c4b545b159b7"><div class="ttname"><a href="classhelib_1_1_arg_map.html#a89eee5d391a2fd41b6b6c4b545b159b7">helib::ArgMap::parse</a></div><div class="ttdeci">ArgMap &amp; parse(int argc, char **argv)</div><div class="ttdoc">Parse the argv array Parse the argv array If it fails or -h is an argument it prints the usage and ex...</div><div class="ttdef"><b>Definition:</b> ArgMap.h:810</div></div>
<div class="ttc" id="aclasshelib_1_1_arg_map_html_ac96d090b5476e9a39b41ae27d74641b0a52f1e315372b38db1b8f4e3666c4f721"><div class="ttname"><a href="classhelib_1_1_arg_map.html#ac96d090b5476e9a39b41ae27d74641b0a52f1e315372b38db1b8f4e3666c4f721">helib::ArgMap::Separator::WHITESPACE</a></div><div class="ttdeci">@ WHITESPACE</div></div>
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
        <script type="text/javascript" src="doxy-boot.js"></script>
</html>
